SegmentScreen

Description

This business rule defines all the fields for the Segment screen.  The business rule is configured to allow modifications to the sort order of the items displayed above the line within the Segment section of the screen.

 SegmentScreen Element/Attribute Table

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<SegmentScreen>

The opening and closing tag for the business rule.

 

 

  <DefaultSegment>

Optional element;

Displays the column with 'Default' name in the segment table grid.

 

Required Element value;

Yes/No

Yes: Adds an additional column called "Default" in the Segment grid.

No: No additional column will be added. This is the default behavior in the absence of this element.

  <DefaultSegmentName>

Optional element;

Defines what segment name to select by default in the coverage dropdown box when the Segment screen is loaded.

 

Required Element value;

SegmentName

Specified Segment Name will be set as default in the Coverage dropdown box.

Note:

If this element is not present then the first alphabetical segment will be selected.  When an invalid segment is specified or the specified valid segment is not valid for the plan the first alphabetical segment will be selected.

   <Table>

Required element;
See Table Element

 

 

   <DisableSegmentFields>

Optional element;
Used to disable segment and role fields for the specified policy status.

 

 

         <DisabledPolicyStatus>

Required element;
Defines policy status codes for the segment fields and role fields on the Segment screen that should be disabled.

 

Required Element value;
StatusCode
Policy status codes (As per AsCode => AsCodeStatus table).

 

SegmentScreen Image

OIPA Segment Screen

 

XML Example

<SegmentScreen>

     <DefaultSegment>No</DefaultSegment>

     <DefaultSegmentName>Base Coverage</DefaultSegmentName>     

     <Table>

          <Column WIDTH="70" ALIGN="Left">

               <Display>Issue Date</Display>

               <Name>SegmentIssueDate</Name>

               <Group>SegmentField</Group>

               <DataType>Date</DataType>

          </Column>

          <Column WIDTH="150" ALIGN="Left">

               <Display>Type</Display>

               <Name>SegmentName</Name>

               <Group>SegmentName</Group>

               <DataType>Text</DataType>

          </Column>

          <Column WIDTH="100" ALIGN="Left">

               <Display>Amount</Display>

               <Name>SegmentAmount</Name>

               <Group>SegmentField</Group>

               <DataType>Money</DataType>

          </Column>

          <Column WIDTH="100" ALIGN="Left">

               <Display>Maturity Date</Display>

               <Name>SegmentMaturityDate</Name>

               <Group>SegmentField</Group>

               <DataType>Date</DataType>

          </Column>

          <Column WIDTH="45" ALIGN="Left">

               <Display>Status</Display>

               <Name>SegmentActiveCode</Name>

               <Group>SegmentField</Group>

               <DataType>Text</DataType>

          </Column>

     </Table>

     <DisableSegmentFields>

          <DisabledPolicyStatus>01,09,10,21,05,29</DisabledPolicyStatus>

     </DisableSegmentFields>

</SegmentScreen>

 

Schema Example

<SegmentScreen>

<DefaultSegment>[Yes|No]</DefaultSegment>

<Table ORDERBY="[Fields from SegmentName business rule | System defined Fields]">

<Column WIDTH="[Integer]" ALIGN="[LEFT|RIGHT]">

<Display>[String]</Display>

<Name>[String]</Name>

</Column>

</Table>

<DisableSegmentFields>

<DisabledPolicyStatus>[StatusCode]</DisabledPolicyStatus>

</DisableSegmentFields>

</SegmentScreen>